bit-Worker RPA OpenApi 开发文档

1、阅读说明

bit-Worker RPA 通过开放接口（OpenApi）为接入企业提供进一步集成和个性化定制的能力。 所有接口都使用 JSON 数据格式和 UTF-8 编码。 接口使用 POST 一种操作，其他类型操作（如 GET、PUT）皆不会用到。 POST 类型操作中可能需要 query 参数。

说明：query 参数是放入 url 中的参数，例如：

https://api.test.ninetechone.com/test-api 在添加 query 参数 id 后完整请求为：
https://api.test.ninetechone.com/test-api?id=xxx

另外，POST 类型操作中除了 query 参数外还可能需要提供 body 参数。具体会在相应业务 API 文档中介绍。

请求返回值中总是包含 code 和 message 字段，称为基础返回字段。用于描述请求的成功状态， 其定义如下：

样例：

// 正确样例
{
  "code": "200",
  "message": "success"
}

// 错误样例
{
  "code": "400",
  "message": "xxx 不能为空"
}

2、接入准备

1、使用租管账号（只有租管具有 API 密钥管理权限）进入 bit-Worker RPA 后台 - API 秘钥

管理，生成秘钥并获取秘钥 secretId 和 secretKey。

● 生成秘钥
点击生成秘钥之后会自动生成秘钥信息，如图： ● 获取秘钥 secretId 和 secretKey 点击查看 secretKey 后弹框要求输入密码，输入账号密码之后获取 secretKey。

2、 拿到密钥对，按照正确的格式进行 base64 加密（中间有空格，且冒号需要使用英文冒号，首字母为小写）地址：

https://base64.us/

3、 加密后的密钥作为获取 token api 的 Access-Secret，通过返回数据拿到调用业务 api 的token

4、 使用 token 作为 header 调用业务 api，header Key 为 Access-Token

说明：

• 每个租管可以申请两个密钥，密码代表您的账号身份和所拥有的权限，请妥善保管。
• 基于生成密钥，可以操作当前的租户下您名下的所有数据，包括但不限于机器人、任务计划、流程等。
• 建议定期更新密钥，保障资产和服务安全。

3、使用说明

调用的域名或 ip，在使用过程中请根据自己的环境进行相应的替换： 例如： https://api.test.ninetechone.com/api/controller/v1/4j 其中，/api/controller/v1/4j 是所有接口 URI 的固定前缀部分。 所有业务接口均需在请求头中添加 Access-Token，作为 key，有关 value 获取方式，请参考接 入准备和授权接口说明。 OpenApi 接口可以组合成多个场景，以下是场景列表及每个场景的接口调用顺序：

3.1 查询机器人列表

1. 查询机器人列表（5.3.1）

   3.2 查询机器人组列表

2. 查询机器人组列表（5.2.1）

   3.3 新增机器人组

3. 查询当前租户下的用户组树（5.1.1）

4. 新增机器人组（5.2.2）

   3.4 修改机器人组

5. 查询当前租户下的用户组树（5.1.1）

6. 查询机器人组详情（5.2.3）

7. 修改机器人组（5.2.4）

   3.5 删除机器人组

8. 查询机器人组列表（5.2.1）

9. 删除机器人组（5.2.5）

   3.6 新增机器人

10. 查询当前用户下的可用机器人 license 列表（指定 license 时调用，不指定创建无 license 机器人）（5.3.2）

11. 查询当前租户下的用户组树（5.1.1）
12. 查询指定用户组下用户列表（5.1.2）
13. 查询指定用户组下的机器人组列表（指定机器人组时调用）（5.2.6）

14. 新增机器人（5.3.3）

    3.7 修改机器人

15. 查询机器人列表（5.3.1）

16. 查询机器人详情（5.3.4）

    3.9 删除机器人

17. 查询机器人列表（5.3.1）

18. 删除机器人（5.3.7）

    3.10 查询流程列表

19. 查询流程列表（5.4.1）

    3.11 查询任务列表

20. 查询任务列表（5.5.1）

    3.12 新增立即执行任务

21. 查询流程列表（5.4.1）

22. 查询流程版本列表（需要选择流程非默认版本时调用）（5.4.2）
23. 查询机器人列表（5.3.1）
24. 查询机器人组列表（指定机器人组运行时调用）（5.2.1）

25. 新增立即执行任务（5.5.2）

    3.13 停止任务

26. 查询任务列表（5.5.1）

27. 停止任务（5.5.3）

    3.14 查询任务详情

28. 查询任务列表（5.5.1）

29. 查询任务详情（5.5.4）

30. 查询任务日志（5.5.5）

    3.15 删除任务

31. 查询任务列表（5.5.1）

32. 删除任务（5.5.6）

    3.16 查询计划列表

33. 查询计划列表（5.6.1）

    3.17 新增计划

34. 查询流程列表（5.4.1）

35. 查询流程版本列表（需要选择流程非默认版本时调用）（5.4.2）
36. 查询机器人列表（5.3.1）
37. 查询机器人组列表（指定机器人组运行时调用）（5.2.1）

38. 新增计划（5.6.2）

    3.18 修改计划

39. 查询计划列表（5.6.1）

40. 查询计划详情（5.6.3）
41. 查询流程列表（5.4.1）
42. 查询流程版本列表（需要选择流程非默认版本时调用）（5.4.2）
43. 查询机器人列表（5.3.1）
44. 查询机器人组列表（指定机器人组运行时调用）(5.2.1)

45. 修改计划（5.6.4）

    3.19 启/禁用计划

46. 查询计划列表（5.6.1）

47. 启/禁用计划（5.6.5）

    3.20 触发网络请求触发计划执行

48. 新增网络请求触发计划（5.6.2）

49. 查询计划列表（5.6.1）

50. 网络请求触发计划 API 接口（5.6.6）

    3.21 查询计划下任务列表

51. 查询计划列表（5.6.1）

52. 查询计划下任务列表（5.6.7）

    3.22 删除计划

53. 查询计划列表（5.6.1）

54. 删除计划（5.6.8）

    4、授权接口

4.1 获取 API 调用凭证 accessToken

接口描述：

获取 accessToken 是调用 bit-Worker RPA openApi 接口的第一步，相当于创建了一个登录凭 证，其它的业务 API 接口，都需要依赖于 accessToken 来鉴权调用者身份。 注意：和惯例不同，获取访问凭据请求采用 POST 方法，且 secret 参数放在 header 中，防止 secret 参数放在 url 中被留在请求日志中影响安全性。

请求格式：

请求头部：

请求参数：

请求示例：

{
"isForce": true
}

返回参数：

响应示例：

请求示例：

{
"userAccount": "test"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": [{
"id": 1,
"name": "父节点",
"pid": 0,
"createTime": "2024-10-12 15:03:00",
"uniqueId": "0:1",
"parentPath": "xxx",
"children": [{
"id": 2,
"name": "子节点",
"pid": 1,
"createTime": "2024-10-12 15:03:00",
"uniqueId": "0:2"
"parentPath": "xxx/1",
"children": []
}]
}]
}

5.1.2 查询指定用户组下用户列表

接口描述：

获取指定用户组下用户列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"orgId": 1
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": [{
"id": 1,
"code": "code1",
"uniqueId": "1:1",
"name": "name1",
"type": 1,
"parentId": 1,
"disabled": false,
"children": []
}]
}

5.2 机器人组相关 5.2.1 查询机器人组列表

接口描述：

获取当前用户有权限的机器人组信息。

请求格式：

请求头部：

请求参数：

请求示例：

{
"name": "test"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": [{
"groupId": 2345,
"name": "test 机器人",
"orgId": 321,
"orgName": "test 用户组"
}]
}

5.2.2 新增机器人组

接口描述：

创建一个新的机器人组。

请求格式：

请求头部：

请求参数：

请求示例：

{
"code": "200",
"message": "success",
"data": {
"groupId": 123
}
}
5.2.3 查询机器人组详情

接口描述：

查询机器人组详情。

请求格式：

请求头部：

请求参数：

请求示例：

{
"groupId": 123
}

返回参数：

响应示例：

{
"groupId": 623,
"name": "20241012",
"orgId": "2820"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.2.5 删除机器人组

接口描述：

删除机器人组。

请求格式：

请求头部：

请求参数：

请求示例：

{
"groupId": 623
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.2.6 查询指定用户组下的机器人组列表

接口描述：

获取指定用户组下的机器人组列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"orgId": 1
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": [
{
"groupId": 261,
"name": "test1"
},
{
"groupId": 622,
"name": "test2"
}
]
}

5.3 机器人相关 5.3.1 查询机器人列表

接口描述：

获取机器人列表。

请求格式：

请求头部：

请求参数：

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"robotId": 2345,
"name": "test 机器人",
"accountList": [
{
"accountId": 1234,
"accountName": "高密度 1",
"status": "IDLE",
"createTime": "2024-10-12 15:15:15",
"updateTime": "2024-10-12 15:15:15"
}
],
"status": "IDLE",
"uuid": "cadce90d5cdf4ecbba97a8d67214f76d",
"groupName": "test 组",
"userAccount": "test_account",
"isEnabled": true,
"createTime": "2024-10-11 15:15:15",
"updateTime": "2024-10-12 15:15:15"
}]
}

5.3.2 查询当前用户下的可用机器人 license 列表

接口描述：

获取当前用户下可用机器人 license 列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"pageIndex": 1,
"pageSize": 10,
"isDistribute": false
}

返回参数：

响应示例：

全部使用 POST 请求为了保证安 applicat Content-Type 是 全性， Content-Type 均为 ion/json application/json Access-Token 是 授权接口所获取的 accessToken

请求参数：

请求示例：

{
"robotName": "test 机器人",
"userId": 1234,
"uuid": "47ff84c531e84303aed70ba3a8a74e7b",
"licenseId": 1
}

返回参数：

响应示例：

{
"robotId": 123
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": {
"robotId": 321,
"name": "test 机器人",
"status": "IDLE"
"uuid": "47ff84c531e84303aed70ba3a8a74e7b",
"userId": 1234,
"userAccount": "test",
"groupIds": [1,2],
"groupNames": ["test1", "test2"],
"licenseId": 1,
"licenseCode": "RoN0jERh",
"orgId": 20,
"orgName": "test 用户组",
"isEnabled": true
}
}

5.3.5 修改机器人

接口描述：

修改机器人属性。

请求格式：

请求头部：

请求参数：

返回参数：

响应示例：

{
"userAccount": "test",
"robotId": 123,
"isEnabled": false
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.3.7 删除机器人

接口描述：

删除机器人。

请求格式：

请求头部：

请求参数：

请求示例：

{
"userAccount": "test",
"robotId": 123
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.4 流程相关 5.4.1 查询流程列表

接口描述：

获取有权限的流程列表。

请求格式：

请求头部：

请求参数：

请求示例：

{}

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"projectId": 2345,
"name": "流程 1",
"version": "V11",
"comment": "12345",
"createTime": "2024-10-12 18:32:00",
"processId": "321",
"parameters":
"[{\"description\":\"\",\"direction\":\"In\",\"edit\":false,\"isF
ile\":true,\"name\":\"file1\",\"typeName\":\"System.String\",\"uu
id\":\"4781\"}]"
}]
}

5.4.2 查询流程版本列表

接口描述：

获取指定流程版本列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"pageIndex": 1,
"pageSize": 10,
"processId": "321"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"projectId": 2345,
"name": "流程 1",
"version": "V1",
"comment": "12345",
"processId": "321",
"createTime": "2024-10-12 18:32:00",
"updateTime": "2024-10-12 18:32:00",
"isDefault": true,
"parameters":
"[{\"description\":\"\",\"direction\":\"In\",\"edit\":false,\"isF
ile\":true,\"name\":\"file1\",\"typeName\":\"System.String\",\"uu
id\":\"4781\"}]"
}]
}

5.5 任务相关 5.5.1 查询任务列表

接口描述：

获取当前租户下的任务列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"pageIndex": 1,
"pageSize": 10
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"taskId": 123,
"projectId": 456,
"projectName": "流程 1",
"projectVersion": "V1",
"robotId": 789,
"robotAccountId": 0,
"robotName": "机器人 1",
"createTime": "2024-10-24 00:00:00",
"startTime": "2024-10-24 09:00:00",
"endTime": null,
"status": "RUNNING",
"flowParamValue": "[]",
"flowResultValue": "[]"
}]
}

5.5.2 新增立即执行任务

接口描述：

创建一个新的立即执行任务。

请求格式：

请求头部：

请求参数：

请求示例：

{
"projectId": 123,
"robotId": 456,
"parameters":
"[{\"description\":\"\",\"direction\":\"In\",\"edit\":false,\"isF
ile\":true,\"name\":\"file1\",\"typeName\":\"System.String\",\"uu
id\":\"4781\"}]"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": {
"taskId": 123,
"timingId": 456
}
}

5.5.3 停止任务

接口描述：

停止当前正在运行的任务。

请求格式：

请求头部：

请求参数：

请求示例：

{
"taskId": 123
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": true
}

5.5.4 查询任务详情

接口描述：

查询任务详情。

请求格式：

请求头部：

请求参数：

请求示例：

{
"taskId": 123
}

返回参数：

响应示例：

5.5.5 查询任务日志

接口描述：

查询任务日志详情。

请求格式：

请求头部：

请求参数：

请求示例：

{
"taskId": 123
}

返回参数：

响应示例：

管）

请求示例：

{
"taskId": 123
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.6 计划相关 5.6.1 查询计划列表

接口描述：

查询当前租户下的计划列表。

请求格式：

请求头部：

请求参数：

请求示例：

{
"pageIndex": 1,
"pageSize": 10
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"timingId": 1234,
"name": "计划 1",
"projectId": 321,
"projectName": "流程 1",
"projectVersion": "V11",
"robotId": 456,
"robotName": "test 机器人",
"createTime": "2024-10-12 18:32:00",
"updateTime": "2024-10-12 18:32:00",
"isEnabled": true
}]
}

5.6.2 新增计划（单次、多次、网络请求触发）

接口描述：

创建一个新的单次执行、多次执行或者网络请求触发计划。

请求格式：

请求头部：

请求参数：

请求示例：

{
"name": "test 计划",
"projectId": 1234,
"robotId": 4321,
"triggerType": "TIMED_TRIGGERED_TASK",
"timingMode": "CRON_EXPRESSIONS",
"cronTab": "0 * * * * ?"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": {
"timingId": 123
}
}

5.6.3 查询计划详情

接口描述：

查询计划详情。

请求格式：

请求头部：

请求参数：

请求示例：

failedRetry Integer 失败重试次数
机器人繁忙处理方式，参考机器人
busyType String
繁忙处理方式表
等待时间，单位分钟，为 0 表示一
queueTimeOut Long
直等待（0 为一直等待）
isRecordVideo Boolean 是否运行时录屏
runAsAdmin Boolean 是否以管理员身份运行
isPictureInPicture Boolean 是否画中画运行
isRecordUpload Boolean 是否记录同步云端
录屏是否本地存储，为 true 表示存
isStoreLocal Boolean
储本地，为 false 表示云端存储

响应示例：

{
"code": "200",
"message": "success",
"data": {
"timingId": 123,
"name": "test 计划",
"processId": 1838473784372281346,
"projectId": 4650,
"projectName": "file_2024092401",
"version": "V3",
"robotId": 11226,
"robotName": "test_ry_2",
"cronTab": "0 * * * * ?",
"startTime": "2024-10-17 16:38:21",
"triggerType": "TIMED_TRIGGERED_TASK",
"timingMode": "CRON_EXPRESSIONS",
"parameters":
"[{\"description\":\"\",\"direction\":\"In\",\"edit\":false,\"isF
ile\":true,\"name\":\"file1\",\"typeName\":\"System.String\",\"uu
id\":\"4781\"}]",
"logLevel": "ALL",
"failedRetry": 3,
"taskType": "QUEUE_UP",
"queueTimeOut": 0,
"isRecordVideo": true,
"runAsAdmin": true,
"isPictureInPicture": false,
"isRecordUpload": false,
"isStoreLocal": true
}
}

5.6.4 修改计划

接口描述：

修改计划信息。

请求格式：

请求头部：

请求参数：

请求示例：

{
"timingId": 123,
"name": "test 计划",
"projectId": 1234,
"robotId": 4321,
"triggerType": "TIMED_TRIGGERED_TASK",
"timingMode": "CRON_EXPRESSIONS",
"cronTab": "0 * * * * ?"
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.6.5 启/禁用计划

接口描述：

启/禁用计划。

请求格式：

请求头部：

请求参数：

请求示例：

{
"timingId": 123,
"isEnabled": false
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

5.6.6 网络请求触发计划 API 接口

接口描述：

通过 API 触发网络请求触发计划执行。

请求格式：

请求头部：

请求参数：

返回参数：

响应示例：

{
"pageIndex": 1,
"pageSize": 10,
"timingId": 123
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"total": 1,
"pageSize": 10,
"page": 1,
"pageIndex": 1,
"data": [{
"taskId": 123,
"projectId": 456,
"projectName": "流程 1",
"projectVersion": "V1",
"robotId": 789,
"robotAccountId": 0,
"robotName": "机器人 1",
"createTime": "2024-10-24 00:00:00",
"startTime": "2024-10-24 09:00:00",
"endTime": null,
"status": "RUNNING",
"flowParamValue": "[]",
"flowResultValue": "[]"
}]
}

5.6.8 删除计划

接口描述：

删除计划。

请求格式：

请求头部：

请求参数：

请求示例：

{
"timingId": 123,
"includeTask": true
}

返回参数：

响应示例：

{
"code": "200",
"message": "success",
"data": null
}

6、 其他说明 6.1 parameters 参数说明 parameters 目前支持两种格式，一种为数组格式字符串，另一种为 json 格式字符串，参考以 下说明。 6.1.2 json 格式字符串 "{\"name1\":\"value1\", \"name2\":\"value2\"}"

• name-参数名
• valye-参数值

  7、码表

7.1 任务状态表

7.2 机器人状态表

7.3 license 类型表

7.4 日志级别表

7.8 机器人繁忙处理方式表

7.9 计划触发类型表

7.10 状态码表